home *** CD-ROM | disk | FTP | other *** search
/ Aminet 40 / Aminet 40 (2000)(Schatztruhe)[!][Dec 2000].iso / Aminet / dev / lang / Python16.lha / Python-1.6 / Lib / Python1.6 / string.py < prev    next >
Encoding:
Python Source  |  2000-04-06  |  10.9 KB  |  403 lines
  1. """A collection of string operations (most are no longer used in Python 1.6).
  2.  
  3. Warning: most of the code you see here isn't normally used nowadays.  With
  4. Python 1.6, many of these functions are implemented as methods on the
  5. standard string object. They used to be implemented by a built-in module
  6. called strop, but strop is now obsolete itself.
  7.  
  8. Public module variables:
  9.  
  10. whitespace -- a string containing all characters considered whitespace
  11. lowercase -- a string containing all characters considered lowercase letters
  12. uppercase -- a string containing all characters considered uppercase letters
  13. letters -- a string containing all characters considered letters
  14. digits -- a string containing all characters considered decimal digits
  15. hexdigits -- a string containing all characters considered hexadecimal digits
  16. octdigits -- a string containing all characters considered octal digits
  17.  
  18. """
  19.  
  20. # Some strings for ctype-style character classification
  21. whitespace = ' \t\n\r\v\f'
  22. lowercase = 'abcdefghijklmnopqrstuvwxyz'
  23. uppercase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
  24. letters = lowercase + uppercase
  25. digits = '0123456789'
  26. hexdigits = digits + 'abcdef' + 'ABCDEF'
  27. octdigits = '01234567'
  28.  
  29. # Case conversion helpers
  30. _idmap = ''
  31. for i in range(256): _idmap = _idmap + chr(i)
  32. del i
  33.  
  34. # Backward compatible names for exceptions
  35. index_error = ValueError
  36. atoi_error = ValueError
  37. atof_error = ValueError
  38. atol_error = ValueError
  39.  
  40. # convert UPPER CASE letters to lower case
  41. def lower(s):
  42.     """lower(s) -> string
  43.  
  44.     Return a copy of the string s converted to lowercase.
  45.  
  46.     """
  47.     return s.lower()
  48.  
  49. # Convert lower case letters to UPPER CASE
  50. def upper(s):
  51.     """upper(s) -> string
  52.  
  53.     Return a copy of the string s converted to uppercase.
  54.  
  55.     """
  56.     return s.upper()
  57.  
  58. # Swap lower case letters and UPPER CASE
  59. def swapcase(s):
  60.     """swapcase(s) -> string
  61.  
  62.     Return a copy of the string s with upper case characters
  63.     converted to lowercase and vice versa.
  64.  
  65.     """
  66.     return s.swapcase()
  67.  
  68. # Strip leading and trailing tabs and spaces
  69. def strip(s):
  70.     """strip(s) -> string
  71.  
  72.     Return a copy of the string s with leading and trailing
  73.     whitespace removed.
  74.  
  75.     """
  76.     return s.strip()
  77.  
  78. # Strip leading tabs and spaces
  79. def lstrip(s):
  80.     """lstrip(s) -> string
  81.  
  82.     Return a copy of the string s with leading whitespace removed.
  83.  
  84.     """
  85.     return s.lstrip()
  86.  
  87. # Strip trailing tabs and spaces
  88. def rstrip(s):
  89.     """rstrip(s) -> string
  90.  
  91.     Return a copy of the string s with trailing whitespace
  92.     removed.
  93.  
  94.     """
  95.     return s.rstrip()
  96.  
  97.  
  98. # Split a string into a list of space/tab-separated words
  99. # NB: split(s) is NOT the same as splitfields(s, ' ')!
  100. def split(s, sep=None, maxsplit=-1):
  101.     """split(s [,sep [,maxsplit]]) -> list of strings
  102.  
  103.     Return a list of the words in the string s, using sep as the
  104.     delimiter string.  If maxsplit is given, splits into at most
  105.     maxsplit words.  If sep is not specified, any whitespace string
  106.     is a separator.
  107.  
  108.     (split and splitfields are synonymous)
  109.  
  110.     """
  111.     return s.split(sep, maxsplit)
  112. splitfields = split
  113.  
  114. # Join fields with optional separator
  115. def join(words, sep = ' '):
  116.     """join(list [,sep]) -> string
  117.  
  118.     Return a string composed of the words in list, with
  119.     intervening occurences of sep.  The default separator is a
  120.     single space.
  121.  
  122.     (joinfields and join are synonymous)
  123.  
  124.     """
  125.     return sep.join(words)
  126. joinfields = join
  127.  
  128. # for a little bit of speed
  129. _apply = apply
  130.  
  131. # Find substring, raise exception if not found
  132. def index(s, *args):
  133.     """index(s, sub [,start [,end]]) -> int
  134.  
  135.     Like find but raises ValueError when the substring is not found.
  136.  
  137.     """
  138.     return _apply(s.index, args)
  139.  
  140. # Find last substring, raise exception if not found
  141. def rindex(s, *args):
  142.     """rindex(s, sub [,start [,end]]) -> int
  143.  
  144.     Like rfind but raises ValueError when the substring is not found.
  145.  
  146.     """
  147.     return _apply(s.rindex, args)
  148.  
  149. # Count non-overlapping occurrences of substring
  150. def count(s, *args):
  151.     """count(s, sub[, start[,end]]) -> int
  152.  
  153.     Return the number of occurrences of substring sub in string
  154.     s[start:end].  Optional arguments start and end are
  155.     interpreted as in slice notation.
  156.  
  157.     """
  158.     return _apply(s.count, args)
  159.  
  160. # Find substring, return -1 if not found
  161. def find(s, *args):
  162.     """find(s, sub [,start [,end]]) -> in
  163.  
  164.     Return the lowest index in s where substring sub is found,
  165.     such that sub is contained within s[start,end].  Optional
  166.     arguments start and end are interpreted as in slice notation.
  167.  
  168.     Return -1 on failure.
  169.  
  170.     """
  171.     return _apply(s.find, args)
  172.  
  173. # Find last substring, return -1 if not found
  174. def rfind(s, *args):
  175.     """rfind(s, sub [,start [,end]]) -> int
  176.  
  177.     Return the highest index in s where substring sub is found,
  178.     such that sub is contained within s[start,end].  Optional
  179.     arguments start and end are interpreted as in slice notation.
  180.  
  181.     Return -1 on failure.
  182.  
  183.     """
  184.     return _apply(s.rfind, args)
  185.  
  186. # for a bit of speed
  187. _float = float
  188. _int = int
  189. _long = long
  190. _StringType = type('')
  191.  
  192. # Convert string to float
  193. def atof(s):
  194.     """atof(s) -> float
  195.  
  196.     Return the floating point number represented by the string s.
  197.  
  198.     """
  199.     return _float(s)
  200.  
  201.  
  202. # Convert string to integer
  203. def atoi(s , base=10):
  204.     """atoi(s [,base]) -> int
  205.  
  206.     Return the integer represented by the string s in the given
  207.     base, which defaults to 10.  The string s must consist of one
  208.     or more digits, possibly preceded by a sign.  If base is 0, it
  209.     is chosen from the leading characters of s, 0 for octal, 0x or
  210.     0X for hexadecimal.  If base is 16, a preceding 0x or 0X is
  211.     accepted.
  212.  
  213.     """
  214.     return _int(s, base)
  215.  
  216.  
  217. # Convert string to long integer
  218. def atol(s, base=10):
  219.     """atol(s [,base]) -> long
  220.  
  221.     Return the long integer represented by the string s in the
  222.     given base, which defaults to 10.  The string s must consist
  223.     of one or more digits, possibly preceded by a sign.  If base
  224.     is 0, it is chosen from the leading characters of s, 0 for
  225.     octal, 0x or 0X for hexadecimal.  If base is 16, a preceding
  226.     0x or 0X is accepted.  A trailing L or l is not accepted,
  227.     unless base is 0.
  228.  
  229.     """
  230.     return _long(s, base)
  231.  
  232.  
  233. # Left-justify a string
  234. def ljust(s, width):
  235.     """ljust(s, width) -> string
  236.  
  237.     Return a left-justified version of s, in a field of the
  238.     specified width, padded with spaces as needed.  The string is
  239.     never truncated.
  240.  
  241.     """
  242.     n = width - len(s)
  243.     if n <= 0: return s
  244.     return s + ' '*n
  245.  
  246. # Right-justify a string
  247. def rjust(s, width):
  248.     """rjust(s, width) -> string
  249.  
  250.     Return a right-justified version of s, in a field of the
  251.     specified width, padded with spaces as needed.  The string is
  252.     never truncated.
  253.  
  254.     """
  255.     n = width - len(s)
  256.     if n <= 0: return s
  257.     return ' '*n + s
  258.  
  259. # Center a string
  260. def center(s, width):
  261.     """center(s, width) -> string
  262.  
  263.     Return a center version of s, in a field of the specified
  264.     width. padded with spaces as needed.  The string is never
  265.     truncated.
  266.  
  267.     """
  268.     n = width - len(s)
  269.     if n <= 0: return s
  270.     half = n/2
  271.     if n%2 and width%2:
  272.         # This ensures that center(center(s, i), j) = center(s, j)
  273.         half = half+1
  274.     return ' '*half +  s + ' '*(n-half)
  275.  
  276. # Zero-fill a number, e.g., (12, 3) --> '012' and (-3, 3) --> '-03'
  277. # Decadent feature: the argument may be a string or a number
  278. # (Use of this is deprecated; it should be a string as with ljust c.s.)
  279. def zfill(x, width):
  280.     """zfill(x, width) -> string
  281.  
  282.     Pad a numeric string x with zeros on the left, to fill a field
  283.     of the specified width.  The string x is never truncated.
  284.  
  285.     """
  286.     if type(x) == type(''): s = x
  287.     else: s = `x`
  288.     n = len(s)
  289.     if n >= width: return s
  290.     sign = ''
  291.     if s[0] in ('-', '+'):
  292.         sign, s = s[0], s[1:]
  293.     return sign + '0'*(width-n) + s
  294.  
  295. # Expand tabs in a string.
  296. # Doesn't take non-printing chars into account, but does understand \n.
  297. def expandtabs(s, tabsize=8):
  298.     """expandtabs(s [,tabsize]) -> string
  299.  
  300.     Return a copy of the string s with all tab characters replaced
  301.     by the appropriate number of spaces, depending on the current
  302.     column, and the tabsize (default 8).
  303.  
  304.     """
  305.     res = line = ''
  306.     for c in s:
  307.         if c == '\t':
  308.             c = ' '*(tabsize - len(line) % tabsize)
  309.         line = line + c
  310.         if c == '\n':
  311.             res = res + line
  312.             line = ''
  313.     return res + line
  314.  
  315. # Character translation through look-up table.
  316. def translate(s, table, deletions=""):
  317.     """translate(s,table [,deletechars]) -> string
  318.  
  319.     Return a copy of the string s, where all characters occurring
  320.     in the optional argument deletechars are removed, and the
  321.     remaining characters have been mapped through the given
  322.     translation table, which must be a string of length 256.
  323.  
  324.     """
  325.     return s.translate(table, deletions)
  326.  
  327. # Capitalize a string, e.g. "aBc  dEf" -> "Abc  def".
  328. def capitalize(s):
  329.     """capitalize(s) -> string
  330.  
  331.     Return a copy of the string s with only its first character
  332.     capitalized.
  333.  
  334.     """
  335.     return s.capitalize()
  336.  
  337. # Capitalize the words in a string, e.g. " aBc  dEf " -> "Abc Def".
  338. # See also regsub.capwords().
  339. def capwords(s, sep=None):
  340.     """capwords(s, [sep]) -> string
  341.  
  342.     Split the argument into words using split, capitalize each
  343.     word using capitalize, and join the capitalized words using
  344.     join. Note that this replaces runs of whitespace characters by
  345.     a single space.
  346.  
  347.     """
  348.     return join(map(capitalize, s.split(sep)), sep or ' ')
  349.  
  350. # Construct a translation string
  351. _idmapL = None
  352. def maketrans(fromstr, tostr):
  353.     """maketrans(frm, to) -> string
  354.  
  355.     Return a translation table (a string of 256 bytes long)
  356.     suitable for use in string.translate.  The strings frm and to
  357.     must be of the same length.
  358.  
  359.     """
  360.     if len(fromstr) != len(tostr):
  361.         raise ValueError, "maketrans arguments must have same length"
  362.     global _idmapL
  363.     if not _idmapL:
  364.         _idmapL = map(None, _idmap)
  365.     L = _idmapL[:]
  366.     fromstr = map(ord, fromstr)
  367.     for i in range(len(fromstr)):
  368.         L[fromstr[i]] = tostr[i]
  369.     return joinfields(L, "")
  370.  
  371. # Substring replacement (global)
  372. def replace(s, old, new, maxsplit=-1):
  373.     """replace (str, old, new[, maxsplit]) -> string
  374.  
  375.     Return a copy of string str with all occurrences of substring
  376.     old replaced by new. If the optional argument maxsplit is
  377.     given, only the first maxsplit occurrences are replaced.
  378.  
  379.     """
  380.     return s.replace(old, new, maxsplit)
  381.  
  382.  
  383. # XXX: transitional
  384. #
  385. # If string objects do not have methods, then we need to use the old string.py
  386. # library, which uses strop for many more things than just the few outlined
  387. # below.
  388. try:
  389.     ''.upper
  390. except AttributeError:
  391.     from stringold import *
  392.  
  393. # Try importing optional built-in module "strop" -- if it exists,
  394. # it redefines some string operations that are 100-1000 times faster.
  395. # It also defines values for whitespace, lowercase and uppercase
  396. # that match <ctype.h>'s definitions.
  397.  
  398. try:
  399.     from strop import maketrans, lowercase, uppercase, whitespace
  400.     letters = lowercase + uppercase
  401. except ImportError:
  402.     pass                                          # Use the original versions
  403.